/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.common;

import org.balisunrise.common.listeners.EntityLoadListener;

/**
 * Esta inteface é responsável por carregar uma lista de entidades do Banco de
 * Dados e armazená-los.
 * @author Glauco
 * @version 1.0
 */
public interface EntityLoader extends Basic{

    /**
     * Retorna a classe da entidade.
     */
    public Class getEntityClass();

    /**
     * Atribui a lista de entidades.
     *
     * @param entityList
     */
    public void setEntityList(EntityList entityList);

    /**
     * Retorna a Lista de Entidades.
     */
    public EntityList getEntityList();

    /**
     * Atribui o número máximo de resultados carregados em cada iteração com
     * o banco de dados.
     * Deixando zero, está opção não será utilizada e todos os registro
     * serão carregados de uma unica vez.
     *
     * @param maxResults
     */
    public void setMaxResults(int maxResults);

    /**
     * Retorna o número máximo de resultados por iteração com o banco de dados.
     */
    public int getMaxResults();

    /**
     * Carrega uma lista de entidades do banco de dados.
     * A antiga lista é descartada.
     * O número de registro carregados depende do valor de maxResults.
     *
     * @param query
     */
    public void load(Query query);

    /**
     * Carrega mais registros do banco de dados para a lista de entidades.
     * O número de registro carregados depende do valor de maxResults.
     */
    public void iterate();

    /**
     * Adiciona um listener.
     *
     * @param listener the listener to be added.
     */
    public void addEntityLoadListener(EntityLoadListener listener);

    /**
     * Remove um listener.
     *
     * @param listener the listener to be removed.
     * @return true if the listener was removed, false if the listener was not
     * included.
     */
    public boolean removeEnityLoadListener(EntityLoadListener listener);

    /**
     * Retorna um array com os listeners.
     *
     * @return
     */
    public EntityLoadListener[] getEntityLoadListeners();
}